home *** CD-ROM | disk | FTP | other *** search
/ Technotools / Technotools (Chestnut CD-ROM)(1993).ISO / lang_oth / lck21b / lck21b.doc < prev    next >
Text File  |  1989-11-14  |  13KB  |  385 lines
  1.  
  2.  
  3.                        LCK Lisp Checker Version 2.1b Manual
  4.  
  5.  
  6.        
  7.        AutoCAD and AutoLISP are registered trademarks of AutoDesk, Inc.
  8.        Turbo Pascal is a registered trademark of Borland International
  9.        PKZIP and PKUNZIP are registered trademarks of PKWARE
  10.  
  11.  
  12.        [ LCK Lisp Checker ]---------------------------------------------
  13.  
  14.        A program written for running checks on AutoLISP files to check 
  15.        the balance of parenthesis and double quotes (string literals). 
  16.        LCK was introduced as shareware software for use with AutoCAD. 
  17.        You may copy and distribute these files freely provided (a) no 
  18.        fee is charged and (b) all of the files are distributed together 
  19.        in their original, unmodified form. Please use the LCK21.ZIP file 
  20.        for uploading to bulletin boards and such. 
  21.  
  22.        If you like LCK and find it useful, your $15 registration fee 
  23.        would be greatly appreciated. A registration form is provided in 
  24.        the file REGISTER.NOW. Registered owners will be notified of 
  25.        future releases. Updates of LCK 2.1 will be made available to all 
  26.        registered owners for the cost of materials, shipping and 
  27.        handling (i.e $5) or the difference in list price. 
  28.  
  29.        Please remember that LCK is not "freeware". If you use LCK, you 
  30.        must register. The trial period is strictly limited to no more 
  31.        than two weeks. 
  32.        
  33.        
  34.        [ Disclaimer ]---------------------------------------------------
  35.        
  36.        There is no warranty for LCK, expressed or implied.  
  37.        CAD/Engineering Services and Stan H. Bimson assumes no liability 
  38.        for damages, direct or consequential, which may result from use 
  39.        of LCK. Use at your own risk! 
  40.        
  41.  
  42.        [ Supplied Files ]-----------------------------------------------
  43.        
  44.        LCK     .EXE    Lisp checker 
  45.        LCK     .DOC    This doc file 
  46.        ERROR   .LSP    A Lisp program on how to handle error messages 
  47.        OSNAP   .LSP    A Lisp program with new OSnap commands
  48.        JUNK    .LSP    A Lisp program with errors 
  49.        REGISTER.NOW    Registration form
  50.  
  51.        
  52.        [ Installation ]-------------------------------------------------
  53.  
  54.        Installation is simple, LCK does not require any configuration. 
  55.        To be able to use LCK from anywhere from within your system, 
  56.        place the LCK.EXE file in a sub-directory that is on your current 
  57.        PATH. 
  58.        
  59.  
  60.        
  61.  
  62.        
  63.        Copyright 1987 CAD/ES                                 Page 1 of 6
  64.  
  65.  
  66.                        LCK Lisp Checker Version 2.1b Manual
  67.  
  68.  
  69.  
  70.        To use LCK from within AutoCAD add the following statement line 
  71.        to your ACAD.PGP file:
  72.  
  73.        lck,lck,65536,*LCK (enter filename): ,0
  74.  
  75.        
  76.        [ System Requirements ]------------------------------------------
  77.  
  78.        LCK will only work on a system with a color monitor. Color is 
  79.        used as a debugging tool. Programs that allow some color programs 
  80.        to run on monochrome monitors will not work with LCK as text is 
  81.        written directly to memory address for the color text area 
  82.        bypassing DOS or BIOS calls. 
  83.        
  84.  
  85.        [ Program Operation ]--------------------------------------------
  86.        
  87.        PARENTHESIS 
  88.        
  89.        15 colors in alternating groups of non-blinking and blinking are 
  90.        used to denote or display the level of parenthesis. The opening 
  91.        and closing parenthesis have the same color. When the end of a 
  92.        code segment is reached unbalanced parenthesis will be noted. If 
  93.        parenthesis are balanced the statement CODE OKAY is shown. 
  94.        
  95.        COMMENTS
  96.  
  97.        When ever and where ever a semicolon is found, the semicolon and 
  98.        the rest of the line is considered a comment. Comments are 
  99.        displayed in the color dark cyan. 
  100.        
  101.        STRING LITERALS
  102.        
  103.        When a quoted ("") string is found, the quote and all the 
  104.        characters that follow until another quote is encountered is 
  105.        considered to be a string literal. String literals have to end on 
  106.        the line that they start on. String literals are displayed in the 
  107.        color light gray. If the program reaches the end of the code line 
  108.        and it has not encountered another quote a string error occurs, 
  109.        an error message is displayed at the end of the line. When a 
  110.        string or quote error has occurred, it can, as it does within 
  111.        AutoCAD, unbalance the parenthesis.  Correct the quote error and 
  112.        rerun LCK to complete the code checking. 
  113.  
  114.        NOTE: Text editors that put a carriage return and line feed 
  115.        (ASCII 13 and 10) in the text file for the end of line, can fake 
  116.        the AutoLISP interpreter. A string CAN continue from one line to 
  117.        the next. The double character code is read in as "\n", a single 
  118.        carriage return would be read as "\r". This is all in compliance 
  119.        with AutoLISP as these control characters are interpreted as 
  120.        being within a string. I feel this is not good coding practice 
  121.        and LCK does not support strings that continue on two or more 
  122.        lines. 
  123.        
  124.  
  125.  
  126.  
  127.        Copyright 1987 CAD/ES                                 Page 2 of 6
  128.  
  129.  
  130.                        LCK Lisp Checker Version 2.1b Manual
  131.  
  132.  
  133.  
  134.        CODE
  135.        
  136.        Is displayed in the color dark green,  all code exceptions have 
  137.        been noted. A line of code, with or without comments may be up
  138.        to 255 characters. Long lines are rapped in the display without 
  139.        incrementing line numbers.
  140.  
  141.        STATUS LINE
  142.  
  143.        Line count is given on the left side of line 25. Parenthesis are 
  144.        counted and the difference of the left minus right is displayed 
  145.        on line 25. Quotes are noted as E for even or U for unbalanced. 
  146.        
  147.        
  148.        [ Syntax ]-------------------------------------------------------
  149.  
  150.        LCK [d:][path]filename[.ext] [/switches]
  151.  
  152.        The file name extension is ONLY required if the AutoLISP file 
  153.        does not have the extension of .LSP. 
  154.  
  155.        LCK junk 
  156.  
  157.        Or: 
  158.  
  159.        LCK 
  160.  
  161.        LCK will stop and ask for a file name. 
  162.  
  163.        
  164.        /switches
  165.  
  166.        Switches cause a change in LCK's operation.
  167.  
  168.        /S
  169.        
  170.        Scroll screen 23 lines (max) at a time. The screen scroll still 
  171.        stops at the end of code segment or the end of the file. Scroll 
  172.        count restarts after each end of code segment.
  173.  
  174.        /NC
  175.        
  176.        No comment display, this covers only the comments that start 
  177.        within a code line. 
  178.  
  179.        /NA
  180.        
  181.        Remove all comments whether they start at the end of a code 
  182.        segment or the beginning of a line. Line numbers which are shown 
  183.        on the left side of screen are shown correctly. Removed comment 
  184.        lines do not change line numbers. 
  185.        
  186.        Switches can be combined in the form:
  187.  
  188.        /SNC or /NCS    Scroll set to 23 and delete line comments
  189.  
  190.  
  191.        Copyright 1987 CAD/ES                                 Page 3 of 6
  192.  
  193.  
  194.                        LCK Lisp Checker Version 2.1b Manual
  195.  
  196.  
  197.  
  198.        /SNA or /NAS    Scroll set to 23 and delete all comments
  199.  
  200.        /NANC or /NCNA  ? Use one or the other, not both, only the first 
  201.                        condition will be in affect
  202.  
  203.        [ Lisp code requirements ]---------------------------------------
  204.  
  205.        There are several code or file structure requirements for LCK. We 
  206.        are not trying to tell or instruct you in how to format your Lisp 
  207.        code.
  208.        
  209.        LCK needs to know what is considered a complete code segment. The 
  210.        following are the code format requirements that LCK will follow.
  211.  
  212.        For LCK to know the end of a section of code that is to be 
  213.        checked: 
  214.  
  215.        (A) Place a blank line between the code segments.
  216.  
  217.        ; Is it a string ?
  218.        (DeFun TestForStr(st)
  219.          (= (Type st) 'STR)
  220.        )
  221.  
  222.        ; Is it a List ?
  223.        (DeFun TestForLst(Lst)
  224.          (= (Type Lst) 'LIST)
  225.        )
  226.  
  227.        (B) Place a single semicolon between the code segments.
  228.  
  229.        ; Is it a string ?
  230.        (DeFun TestForStr(st)
  231.          (= (Type st) 'STR)
  232.        )
  233.        ;
  234.        ; Is it a List ?
  235.        (DeFun TestForLst(Lst)
  236.          (= (Type Lst) 'LIST)
  237.        )
  238.  
  239.        Tab Characters
  240.  
  241.        If your text editor inserts a tab character (ASCII 9) instead of 
  242.        expanding with space characters be forewarned that LCK will only 
  243.        expand the tab to a single space. This may cause the displayed 
  244.        code not to look like how you formatted it.
  245.  
  246.        
  247.  
  248.        
  249.  
  250.  
  251.  
  252.  
  253.  
  254.  
  255.        Copyright 1987 CAD/ES                                 Page 4 of 6
  256.  
  257.  
  258.                        LCK Lisp Checker Version 2.1b Manual
  259.  
  260.  
  261.  
  262.        [ Parting Comments ]---------------------------------------------
  263.        
  264.        I would be pleased to hear any comments on this program be they 
  265.        bad or good, I am not a professional programmer but a freelance 
  266.        structural steel draftsman that uses AutoCAD. I program heavily 
  267.        into AutoLISP and as you see by this program, in Turbo Pascal. I 
  268.        feel that this program is a very good aid for any level of 
  269.        AutoLISP programmer. 
  270.  
  271.        As many people have found out, my business and home telephone is 
  272.        one in the same. I wish to thank these people for calling at a 
  273.        reasonable hour (at my end). People who have called on Saturday 
  274.        and Sunday have occasionally have found me "out". If you call and 
  275.        I am "out", please give who ever answers the telephone some idea 
  276.        of why you called. My wife and children can not answer questions 
  277.        about LCK, Pascal or AutoLISP, but they take good messages and 
  278.        generally know when I will be back.
  279.        
  280.        In all these years I have only received one (1) call about a 
  281.        "bug" in LCK, I do return calls covering "bug" reports. If you 
  282.        experience some problem with LCK please re-read this manual 
  283.        before calling, I have had many calls because people do not 
  284.        follow the two simple forms of code formatting. 
  285.        
  286.        Some people have just called to "shoot the breeze" about a LISP 
  287.        program I have written, they have or are writing, AutoLISP in 
  288.        general, AutoCAD, Pascal or structural steel detailing. I don't 
  289.        really mind these calls, I need a break once and while and have 
  290.        even learned more than I have given, but I do have to work. 
  291.        Calling on the weekend doesn't help, I don't sit around the house 
  292.        or watch TV. It's Boy Scouts, yard work, my family, beta testing 
  293.        (someone else's program), programming (my own), or something. 
  294.        It's "catch as catch can" most of the time.
  295.  
  296.        I can be reached at two bulletin boards:
  297.  
  298.        The AutoDesk forum on CompuServe, user ID# 73507,3475, I call
  299.        every Saturday morning (once a week) unless I have message 
  300.        replies to send.
  301.  
  302.        OR
  303.  
  304.        The EET BBS, Nashville, TN. Telephone (615) 353-3476, which I 
  305.        call everyday or every other day.
  306.  
  307.        National AutoCAD Echo or National CAD/M Echo:
  308.  
  309.        If your local BBS carries either of these National Echos, I check 
  310.        both as EET carries both. 
  311.  
  312.        Mailing Addresses:                       Telephone:
  313.  
  314.            CAD/Engineering Services             (615) 824-4938
  315.            1038 Forest Harbor Drive
  316.            Hendersonville, TN 37075-9646 USA
  317.  
  318.  
  319.        Copyright 1987 CAD/ES                                 Page 5 of 6
  320.  
  321.  
  322.                        LCK Lisp Checker Version 2.1b Manual
  323.  
  324.  
  325.  
  326.        [ Distribution Disk ]--------------------------------------------
  327.  
  328.        Distribution disk and upgrade disk have the files noted in the 
  329.        section Supplied Files. These files are found in the root 
  330.        directory of the diskette.
  331.        
  332.        The Supplied Files do not take up much disk space. I really hate 
  333.        to send out a diskette with all that empty space so there is 
  334.        usually a sub-directory named EXTRAS. In this directory are files 
  335.        that I find of interest to me, either for DOS operations or my 
  336.        dealing with AutoCAD or AutoLISP. 
  337.        
  338.        These programs are public domain, some have documentation and 
  339.        some don't. I don't support these programs in anyway, nor do I 
  340.        take any liability for them, all the risk is incurred by the 
  341.        user. These files change from time to time so no documentation 
  342.        list is given. 
  343.  
  344.        
  345.        [ Version Notation ]---------------------------------------------
  346.        
  347.        2.1b    Copy distributed to AutoCAD BBS and CompuServe
  348.        2.1z    Registered user copy
  349.  
  350.  
  351.  
  352.  
  353.  
  354.  
  355.  
  356.  
  357.  
  358.  
  359.  
  360.  
  361.  
  362.  
  363.  
  364.  
  365.  
  366.  
  367.  
  368.  
  369.  
  370.  
  371.  
  372.  
  373.  
  374.  
  375.  
  376.  
  377.  
  378.        End of Manual
  379.  
  380.  
  381.  
  382.        
  383.        Copyright 1987 CAD/ES                                 Page 6 of 6
  384.  
  385.